<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wickr-crypto-c: wickr_cipher Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">wickr-crypto-c
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">wickr_cipher Struct Reference<div class="ingroups"><a class="el" href="group__wickr__cipher.html">wickr_cipher_t</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents a cipher that can be used in the crypto_engine. This meta object holds parameters for the cipher algorithms and maintains an identifier that can be used to look up the desired parameters for an algorithm.  
 <a href="structwickr__cipher.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="cipher_8h_source.html">cipher.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a2ce240f5bd396df05ddd4f30ba944b36"><td class="memItemLeft" align="right" valign="top">wickr_cipher_id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__cipher.html#a2ce240f5bd396df05ddd4f30ba944b36">cipher_id</a></td></tr>
<tr class="separator:a2ce240f5bd396df05ddd4f30ba944b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec5724cc59d20ae5d7cbb73684b53457"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__cipher.html#aec5724cc59d20ae5d7cbb73684b53457">key_len</a></td></tr>
<tr class="separator:aec5724cc59d20ae5d7cbb73684b53457"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cd39366934a31345d63ff42deeac1e3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__cipher.html#a1cd39366934a31345d63ff42deeac1e3">iv_len</a></td></tr>
<tr class="separator:a1cd39366934a31345d63ff42deeac1e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ec0af7f260a3f14e31ce8db899aa06e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__cipher.html#a5ec0af7f260a3f14e31ce8db899aa06e">auth_tag_len</a></td></tr>
<tr class="separator:a5ec0af7f260a3f14e31ce8db899aa06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21499cb78c9db301261c9d0d647b3e50"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__cipher.html#a21499cb78c9db301261c9d0d647b3e50">is_authenticated</a></td></tr>
<tr class="separator:a21499cb78c9db301261c9d0d647b3e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a cipher that can be used in the crypto_engine. This meta object holds parameters for the cipher algorithms and maintains an identifier that can be used to look up the desired parameters for an algorithm. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5ec0af7f260a3f14e31ce8db899aa06e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ec0af7f260a3f14e31ce8db899aa06e">&#9670;&nbsp;</a></span>auth_tag_len</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_cipher::auth_tag_len</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the size of the authentication tag required by the cipher to authenticate output of the cipher </p>

</div>
</div>
<a id="a2ce240f5bd396df05ddd4f30ba944b36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ce240f5bd396df05ddd4f30ba944b36">&#9670;&nbsp;</a></span>cipher_id</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_cipher::cipher_id</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>identifier for the cipher to be used in serialization / deserialization to load a particular set of cipher parameters </p>

</div>
</div>
<a id="a21499cb78c9db301261c9d0d647b3e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21499cb78c9db301261c9d0d647b3e50">&#9670;&nbsp;</a></span>is_authenticated</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_cipher::is_authenticated</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>specifies if the cipher requires authentication. If is_authenticated is true, then auth_tag_len must be non-zero </p>

</div>
</div>
<a id="a1cd39366934a31345d63ff42deeac1e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cd39366934a31345d63ff42deeac1e3">&#9670;&nbsp;</a></span>iv_len</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_cipher::iv_len</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the size of the nonce in bytes required to cipher / decipher input </p>

</div>
</div>
<a id="aec5724cc59d20ae5d7cbb73684b53457"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec5724cc59d20ae5d7cbb73684b53457">&#9670;&nbsp;</a></span>key_len</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_cipher::key_len</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the size of a key in bytes required to cipher / decipher input </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/wickrcrypto/include/wickrcrypto/<a class="el" href="cipher_8h_source.html">cipher.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
